home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / src / exampleCode / video / scrollmon / README < prev    next >
Encoding:
Text File  |  1994-08-02  |  4.1 KB  |  96 lines
  1.  
  2.            ~4Dgifts/toolbox/src/exampleCode/video/scrollmon README
  3.  
  4.  
  5. scrollmon 1.1
  6.  
  7. An application for creating realtime scrolling credits or titles (graphics) for
  8. video production.  Credits can be constructed from either anti-aliased text or
  9. SGI rgb images.
  10.  
  11. scrollmon, when executed reads a description file, defaultly credits.txt in
  12. the local directory, and builds a series of bitmaps that it scrolls in a 4.0
  13. Glx window.  The scrolling attributes such as the speed, color, etc are
  14. based on the parameters in the file and on the command line.
  15.  
  16. NEW for 1.1!
  17. -=-=-=--=-=-
  18. There are now menus as part of the interface that let you either re-read the
  19. credits file or open an entirely different one while the app is running.
  20. It also does a better job of refreshing the graphics if you obscure the credits
  21. window.  Lastly there is a second button on the control panel that basically
  22. starts the reroll of the credits.  Using this in conjunction with the stop
  23. start button you can set up the credits for a roll eg. press the stop button
  24. then press the rescroll button, now when you press the go button it will start
  25. the credits from the beginning.  Not perfect but it should help with the timing
  26. of the roll.
  27.  
  28.  
  29. The options to scrollmon are as follows:
  30.  
  31. # scrollmon -help
  32. usage:  scrollmon  [-options ...] [credits file]
  33. where options include:
  34.     -p[erf]                          show performance indicator and perf msgs
  35.     -d[ebug]                         print debug messages
  36.     -f[ps] <frames per second>       set update rate, default = refresh rate
  37.     -s[peed] <scan lines>            set speed by # of scan lines to move in y
  38.     -w[idth] <# pixels>              window width in pixels (default 640)
  39.     -h[eight] <# pixels>             window height in pixels (default 480)
  40.     -h[elp]                          print this usage message
  41.  
  42. The precise regularity of the graphics updates is key to having smooth, non-
  43. interrupted scrolled graphics for video.  Although it is not always possible
  44. to guarantee this 100% because of other system activity it is possible to 
  45. significantly increase the likelihood of this behavior by raising the priority
  46. of the process to NDPHIMIN and setting the process such that it is immune to 
  47. process swapout.  This program is built with code that does this but in order
  48. for this to be executed the process must be run as root or run setuid with 
  49. root permissions.
  50.  
  51.  
  52. As stated above, the credits source file defaults to credits.txt in the local
  53. directory.  The one included with this example has a header which describes all
  54. the directives possible for the description of the credit elements.
  55.  
  56. #
  57. # **** Definitions for commands *****
  58. #
  59. #   All command lines begin with a ':' followed by one of the following
  60. #   command words and their associated parameters
  61. # : COLOR <red value> <green value> <blue value> <colorname>  - black is defnd
  62. # : FONT <fontname> <pointsize> <colorname> <justify(C,L,R)> <angle> <spacing>
  63. # : IMAGE <filename> <x offset> <y offset>
  64. # : LMARGIN <# of pixels from the left>
  65. # : RMARGIN <# of pixels from the right>
  66. # : BGCOL <colorname>  - defaults to black
  67. # 
  68. # All lines beginning with a '#' are comment lines.
  69. # All other lines are lines of text which will be rendered with the most
  70. # recent FONT command properties.
  71. #
  72.  
  73.  
  74. Currently, scrollmon's video button is non-functional.  In a future release
  75. you will be able to combine the text and images with live video in the same
  76. window and record the resulting composite images.
  77.  
  78.  
  79. NOTE: For use on Irix 4.0.x
  80.  
  81. This application was built to run in a 5.1.x environment but can be built to
  82. run on 4.0.x systems. Use Makefile.irix4 to build on 4.0.x machines.  In order
  83. to have the colored pixmaps work correctly you should install the X resource
  84. defaults contained in Scrollmon either by using the 'xrdb -merge' command or
  85. by including the lines in that file in you .Xdefaults file or bye using the
  86. "run" script included in the source directory.
  87.  
  88. BUGS:
  89.  
  90.   Because of a bug in the libwfm library this application will not run on a
  91. remote machine (dgl error).  If you want this functionality you can replace the
  92. libwfm calls with the equivalent libfm calls.  You will lose the ability to
  93. render anti-aliased fonts, however.
  94.  
  95.  
  96.